<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>XPath xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/jaxen/XPath.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> org.jaxen;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> $Id: XPath.java 1304 2007-05-02 15:00:13Z elharo $</em>
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <em class="comment"> Copyright 2003 The Werken Company. All Rights Reserved.</em>
<a name="7" href="#7">7</a>   <em class="comment"> </em>
<a name="8" href="#8">8</a>   <em class="comment">Redistribution and use in source and binary forms, with or without</em>
<a name="9" href="#9">9</a>   <em class="comment">modification, are permitted provided that the following conditions are</em>
<a name="10" href="#10">10</a>  <em class="comment">met:</em>
<a name="11" href="#11">11</a>  
<a name="12" href="#12">12</a>  <em class="comment">  * Redistributions of source code must retain the above copyright</em>
<a name="13" href="#13">13</a>  <em class="comment">    notice, this list of conditions and the following disclaimer.</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <em class="comment">  * Redistributions in binary form must reproduce the above copyright</em>
<a name="16" href="#16">16</a>  <em class="comment">    notice, this list of conditions and the following disclaimer in the</em>
<a name="17" href="#17">17</a>  <em class="comment">    documentation and/or other materials provided with the distribution.</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em class="comment">  * Neither the name of the Jaxen Project nor the names of its</em>
<a name="20" href="#20">20</a>  <em class="comment">    contributors may be used to endorse or promote products derived </em>
<a name="21" href="#21">21</a>  <em class="comment">    from this software without specific prior written permission.</em>
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <em class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="24" href="#24">24</a>  <em class="comment">IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="25" href="#25">25</a>  <em class="comment">TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="26" href="#26">26</a>  <em class="comment">PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="27" href="#27">27</a>  <em class="comment">OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="28" href="#28">28</a>  <em class="comment">EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="29" href="#29">29</a>  <em class="comment">PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="30" href="#30">30</a>  <em class="comment">PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="31" href="#31">31</a>  <em class="comment">LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="32" href="#32">32</a>  <em class="comment">NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="33" href="#33">33</a>  <em class="comment">SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <em class="comment"> */</em>
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <strong>import</strong> java.util.List;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  <em>/**</em><em> Represents an XPath 1.0 expression which</em>
<a name="40" href="#40">40</a>  <em> *  can be evaluated against a variety of different XML object models.</em>
<a name="41" href="#41">41</a>  <em> *</em>
<a name="42" href="#42">42</a>  <em> *  &lt;p></em>
<a name="43" href="#43">43</a>  <em> *  Most of the evaluation methods take a context object. This is typically a</em>
<a name="44" href="#44">44</a>  <em> *  node or node-set object (which is typically a &lt;code>List&lt;/code></em>
<a name="45" href="#45">45</a>  <em> *  of node objects) or a Jaxen &lt;code>Context&lt;/code> object.</em>
<a name="46" href="#46">46</a>  <em> *  A null context is allowed, meaning that </em>
<a name="47" href="#47">47</a>  <em> *  there are no XML nodes on which to evaluate.</em>
<a name="48" href="#48">48</a>  <em> *  &lt;/p></em>
<a name="49" href="#49">49</a>  <em> *</em>
<a name="50" href="#50">50</a>  <em> *  @see org.jaxen.dom4j.Dom4jXPath XPath for dom4j</em>
<a name="51" href="#51">51</a>  <em> *  @see org.jaxen.jdom.JDOMXPath  XPath for JDOM</em>
<a name="52" href="#52">52</a>  <em> *  @see org.jaxen.dom.DOMXPath   XPath for W3C DOM</em>
<a name="53" href="#53">53</a>  <em> *</em>
<a name="54" href="#54">54</a>  <em> *  @author &lt;a href="<a href="mailto:bob@eng.werken.com" target="alexandria_uri">mailto:bob@eng.werken.com</a>">bob mcwhirter&lt;/a></em>
<a name="55" href="#55">55</a>  <em> *  @author &lt;a href="<a href="mailto:jstrachan@apache.org" target="alexandria_uri">mailto:jstrachan@apache.org</a>">James Strachan&lt;/a></em>
<a name="56" href="#56">56</a>  <em> */</em>
<a name="57" href="#57">57</a>  <strong>public</strong> <strong>interface</strong> <a href="../../org/jaxen/XPath.html">XPath</a>
<a name="58" href="#58">58</a>  {
<a name="59" href="#59">59</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="60" href="#60">60</a>      <em class="comment">//     Basic Evaluation</em>
<a name="61" href="#61">61</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <em>/**</em><em> Evaluate this XPath against the given context.</em>
<a name="64" href="#64">64</a>  <em>     *</em>
<a name="65" href="#65">65</a>  <em>     *  &lt;p></em>
<a name="66" href="#66">66</a>  <em>     *  The context of evaluation my be a &lt;em>document&lt;/em>,</em>
<a name="67" href="#67">67</a>  <em>     *  an &lt;em>element&lt;/em>, or a set of &lt;em>elements&lt;/em>.</em>
<a name="68" href="#68">68</a>  <em>     *  &lt;/p></em>
<a name="69" href="#69">69</a>  <em>     *</em>
<a name="70" href="#70">70</a>  <em>     *  &lt;p></em>
<a name="71" href="#71">71</a>  <em>     *  If the expression evaluates to an XPath string, number, or boolean</em>
<a name="72" href="#72">72</a>  <em>     *  type, then the equivalent Java object type is returned.  </em>
<a name="73" href="#73">73</a>  <em>     *  Otherwise, if the result is a node-set, then the returned value is a</em>
<a name="74" href="#74">74</a>  <em>     *  &lt;code>List&lt;/code>.</em>
<a name="75" href="#75">75</a>  <em>     *  &lt;/p></em>
<a name="76" href="#76">76</a>  <em>     *</em>
<a name="77" href="#77">77</a>  <em>     *  &lt;p></em>
<a name="78" href="#78">78</a>  <em>     *  When using this method, one must be careful to</em>
<a name="79" href="#79">79</a>  <em>     *  test the class of the returned objects, and of </em>
<a name="80" href="#80">80</a>  <em>     *  each of the composite members if a &lt;code>List&lt;/code></em>
<a name="81" href="#81">81</a>  <em>     *  is returned.  If the returned members are XML nodes,</em>
<a name="82" href="#82">82</a>  <em>     *  they will be the actual &lt;code>Document&lt;/code>,</em>
<a name="83" href="#83">83</a>  <em>     *  &lt;code>Element&lt;/code> or &lt;code>Attribute&lt;/code> objects</em>
<a name="84" href="#84">84</a>  <em>     *  as defined by the concrete XML object-model implementation,</em>
<a name="85" href="#85">85</a>  <em>     *  directly from the context document.  This method &lt;strong>does not</em>
<a name="86" href="#86">86</a>  <em>     *  return &lt;em>copies&lt;/em> of anything&lt;/strong>. It merely returns</em>
<a name="87" href="#87">87</a>  <em>     *  references to nodes within the source document.</em>
<a name="88" href="#88">88</a>  <em>     *  &lt;/p></em>
<a name="89" href="#89">89</a>  <em>     *  </em>
<a name="90" href="#90">90</a>  <em>     *  @param context the node, node-set or Context object for evaluation. </em>
<a name="91" href="#91">91</a>  <em>     *         This value can be null.</em>
<a name="92" href="#92">92</a>  <em>     *</em>
<a name="93" href="#93">93</a>  <em>     *  @return the result of evaluating the XPath expression</em>
<a name="94" href="#94">94</a>  <em>     *          against the supplied context</em>
<a name="95" href="#95">95</a>  <em>     *</em>
<a name="96" href="#96">96</a>  <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="97" href="#97">97</a>  <em>     *          to evaluate the expression</em>
<a name="98" href="#98">98</a>  <em>     */</em>
<a name="99" href="#99">99</a>      Object evaluate(Object context) throws JaxenException;
<a name="100" href="#100">100</a>     
<a name="101" href="#101">101</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="102" href="#102">102</a>     <em class="comment">//     Advanced Evaluation</em>
<a name="103" href="#103">103</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="104" href="#104">104</a>     
<a name="105" href="#105">105</a>     <em>/**</em><em> Retrieve a string-value interpretation of this XPath</em>
<a name="106" href="#106">106</a> <em>     *  expression when evaluated against the given context.</em>
<a name="107" href="#107">107</a> <em>     *</em>
<a name="108" href="#108">108</a> <em>     *  &lt;p></em>
<a name="109" href="#109">109</a> <em>     *  The string-value of the expression is determined per</em>
<a name="110" href="#110">110</a> <em>     *  the &lt;code>string(..)&lt;/code> core function as defined</em>
<a name="111" href="#111">111</a> <em>     *  in the XPath specification.  This means that an expression</em>
<a name="112" href="#112">112</a> <em>     *  that selects more than one nodes will return the string value</em>
<a name="113" href="#113">113</a> <em>     *  of the first node in the node set..</em>
<a name="114" href="#114">114</a> <em>     *  &lt;/p></em>
<a name="115" href="#115">115</a> <em>     *</em>
<a name="116" href="#116">116</a> <em>     *  @deprecated use {@link #stringValueOf(Object)} instead</em>
<a name="117" href="#117">117</a> <em>     *</em>
<a name="118" href="#118">118</a> <em>     *  @param context the node, node-set or Context object for evaluation. </em>
<a name="119" href="#119">119</a> <em>     *         This value can be null.</em>
<a name="120" href="#120">120</a> <em>     *</em>
<a name="121" href="#121">121</a> <em>     *  @return the string-value of this expression</em>
<a name="122" href="#122">122</a> <em>     *</em>
<a name="123" href="#123">123</a> <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="124" href="#124">124</a> <em>     *          to evaluate the expression</em>
<a name="125" href="#125">125</a> <em>     */</em>
<a name="126" href="#126">126</a>     String valueOf(Object context)
<a name="127" href="#127">127</a>         throws JaxenException;
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>     <em>/**</em><em> Retrieve a string-value interpretation of this XPath</em>
<a name="130" href="#130">130</a> <em>     *  expression when evaluated against the given context.</em>
<a name="131" href="#131">131</a> <em>     *</em>
<a name="132" href="#132">132</a> <em>     *  &lt;p></em>
<a name="133" href="#133">133</a> <em>     *  The string-value of the expression is determined per</em>
<a name="134" href="#134">134</a> <em>     *  the &lt;code>string(..)&lt;/code> core function as defined</em>
<a name="135" href="#135">135</a> <em>     *  in the XPath specification.  This means that an expression</em>
<a name="136" href="#136">136</a> <em>     *  that selects more than one nodes will return the string value</em>
<a name="137" href="#137">137</a> <em>     *  of the first node in the node set..</em>
<a name="138" href="#138">138</a> <em>     *  &lt;/p></em>
<a name="139" href="#139">139</a> <em>     *</em>
<a name="140" href="#140">140</a> <em>     *  @param context the node, node-set or Context object for evaluation. </em>
<a name="141" href="#141">141</a> <em>     *     This value can be null</em>
<a name="142" href="#142">142</a> <em>     *</em>
<a name="143" href="#143">143</a> <em>     *  @return the string-value interpretation of this expression</em>
<a name="144" href="#144">144</a> <em>     *</em>
<a name="145" href="#145">145</a> <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="146" href="#146">146</a> <em>     *          to evaluate the expression</em>
<a name="147" href="#147">147</a> <em>     */</em>
<a name="148" href="#148">148</a>      String stringValueOf(Object context)
<a name="149" href="#149">149</a>         throws JaxenException;
<a name="150" href="#150">150</a>     
<a name="151" href="#151">151</a>     <em>/**</em><em> Retrieve the boolean value of the first node in document order</em>
<a name="152" href="#152">152</a> <em>     *  returned by this XPath expression when evaluated in </em>
<a name="153" href="#153">153</a> <em>     *  the given context.</em>
<a name="154" href="#154">154</a> <em>     *</em>
<a name="155" href="#155">155</a> <em>     *  &lt;p></em>
<a name="156" href="#156">156</a> <em>     *  The boolean-value of the expression is determined per</em>
<a name="157" href="#157">157</a> <em>     *  the &lt;code>boolean()&lt;/code> function defined</em>
<a name="158" href="#158">158</a> <em>     *  in the XPath specification.  This means that an expression</em>
<a name="159" href="#159">159</a> <em>     *  that selects zero nodes will return &lt;code>false&lt;/code>,</em>
<a name="160" href="#160">160</a> <em>     *  while an expression that selects one or more nodes will</em>
<a name="161" href="#161">161</a> <em>     *  return &lt;code>true&lt;/code>. An expression that returns a string</em>
<a name="162" href="#162">162</a> <em>     *  returns false for empty strings and true for all other strings.</em>
<a name="163" href="#163">163</a> <em>     *  An expression that returns a number</em>
<a name="164" href="#164">164</a> <em>     *  returns false for zero and true for non-zero numbers.</em>
<a name="165" href="#165">165</a> <em>     *  &lt;/p></em>
<a name="166" href="#166">166</a> <em>     *</em>
<a name="167" href="#167">167</a> <em>     *  @param context the node, node-set or Context object for evaluation. This value can be null.</em>
<a name="168" href="#168">168</a> <em>     *</em>
<a name="169" href="#169">169</a> <em>     *  @return the boolean-value of this expression</em>
<a name="170" href="#170">170</a> <em>     *</em>
<a name="171" href="#171">171</a> <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="172" href="#172">172</a> <em>     *          to evaluate the expression</em>
<a name="173" href="#173">173</a> <em>     */</em>
<a name="174" href="#174">174</a>     <strong>boolean</strong> <strong>boolean</strong>ValueOf(Object context)
<a name="175" href="#175">175</a>         throws JaxenException;
<a name="176" href="#176">176</a>     
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>     <em>/**</em><em> Retrieve the number-value of the first node in document order</em>
<a name="179" href="#179">179</a> <em>     *  returned by this XPath expression when evaluated in </em>
<a name="180" href="#180">180</a> <em>     *  the given context.</em>
<a name="181" href="#181">181</a> <em>     *</em>
<a name="182" href="#182">182</a> <em>     *  &lt;p></em>
<a name="183" href="#183">183</a> <em>     *  The number-value of the expression is determined per</em>
<a name="184" href="#184">184</a> <em>     *  the &lt;code>number(..)&lt;/code> core function as defined</em>
<a name="185" href="#185">185</a> <em>     *  in the XPath specification. This means that if this</em>
<a name="186" href="#186">186</a> <em>     *  expression selects multiple nodes, the number-value</em>
<a name="187" href="#187">187</a> <em>     *  of the first node is returned.</em>
<a name="188" href="#188">188</a> <em>     *  &lt;/p></em>
<a name="189" href="#189">189</a> <em>     *</em>
<a name="190" href="#190">190</a> <em>     *  @param context the node, node-set or Context object for evaluation. This value can be null.</em>
<a name="191" href="#191">191</a> <em>     *</em>
<a name="192" href="#192">192</a> <em>     *  @return the number-value interpretation of this expression</em>
<a name="193" href="#193">193</a> <em>     *</em>
<a name="194" href="#194">194</a> <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="195" href="#195">195</a> <em>     *          to evaluate the expression</em>
<a name="196" href="#196">196</a> <em>     */</em>
<a name="197" href="#197">197</a>     Number numberValueOf(Object context)
<a name="198" href="#198">198</a>         throws JaxenException;
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="201" href="#201">201</a>     <em class="comment">//     Selection</em>
<a name="202" href="#202">202</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a>     <em>/**</em><em> Select all nodes that are selectable by this XPath</em>
<a name="205" href="#205">205</a> <em>     *  expression. If multiple nodes match, multiple nodes</em>
<a name="206" href="#206">206</a> <em>     *  will be returned.</em>
<a name="207" href="#207">207</a> <em>     *</em>
<a name="208" href="#208">208</a> <em>     *  &lt;p></em>
<a name="209" href="#209">209</a> <em>     *  &lt;strong>NOTE:&lt;/strong> In most cases, nodes will be returned</em>
<a name="210" href="#210">210</a> <em>     *  in document-order, as defined by the XML Canonicalization</em>
<a name="211" href="#211">211</a> <em>     *  specification.  The exception occurs when using XPath</em>
<a name="212" href="#212">212</a> <em>     *  expressions involving the &lt;code>union&lt;/code> operator</em>
<a name="213" href="#213">213</a> <em>     *  (denoted with the pipe '|' character).</em>
<a name="214" href="#214">214</a> <em>     *  &lt;/p></em>
<a name="215" href="#215">215</a> <em>     *</em>
<a name="216" href="#216">216</a> <em>     *  @see #selectSingleNode</em>
<a name="217" href="#217">217</a> <em>     *</em>
<a name="218" href="#218">218</a> <em>     *  @param context the node, node-set or Context object for evaluation. </em>
<a name="219" href="#219">219</a> <em>     *     This value can be null.</em>
<a name="220" href="#220">220</a> <em>     *</em>
<a name="221" href="#221">221</a> <em>     *  @return the node-set of all items selected</em>
<a name="222" href="#222">222</a> <em>     *          by this XPath expression.</em>
<a name="223" href="#223">223</a> <em>     *</em>
<a name="224" href="#224">224</a> <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="225" href="#225">225</a> <em>     *          to evaluate the expression</em>
<a name="226" href="#226">226</a> <em>     */</em>
<a name="227" href="#227">227</a>     List selectNodes(Object context)
<a name="228" href="#228">228</a>         throws JaxenException;
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>     <em>/**</em><em> </em>
<a name="231" href="#231">231</a> <em>     *  &lt;p></em>
<a name="232" href="#232">232</a> <em>     *  Return the first node in document order that is selected by this </em>
<a name="233" href="#233">233</a> <em>     *  XPath expression.</em>
<a name="234" href="#234">234</a> <em>     *  &lt;/p></em>
<a name="235" href="#235">235</a> <em>     *</em>
<a name="236" href="#236">236</a> <em>     *  @see #selectNodes</em>
<a name="237" href="#237">237</a> <em>     *</em>
<a name="238" href="#238">238</a> <em>     *  @param context the node, node-set or Context object for evaluation. </em>
<a name="239" href="#239">239</a> <em>     *     This value can be null.</em>
<a name="240" href="#240">240</a> <em>     *</em>
<a name="241" href="#241">241</a> <em>     *  @return the first node in document order selected by this XPath expression</em>
<a name="242" href="#242">242</a> <em>     *</em>
<a name="243" href="#243">243</a> <em>     *  @throws JaxenException if an error occurs while attempting</em>
<a name="244" href="#244">244</a> <em>     *          to evaluate the expression</em>
<a name="245" href="#245">245</a> <em>     */</em>
<a name="246" href="#246">246</a>     Object selectSingleNode(Object context)
<a name="247" href="#247">247</a>         throws JaxenException;
<a name="248" href="#248">248</a>     
<a name="249" href="#249">249</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="250" href="#250">250</a>     <em class="comment">//     Helpers</em>
<a name="251" href="#251">251</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="252" href="#252">252</a> 
<a name="253" href="#253">253</a>     <em>/**</em><em> Add a namespace prefix-to-URI mapping for this XPath</em>
<a name="254" href="#254">254</a> <em>     *  expression.</em>
<a name="255" href="#255">255</a> <em>     *</em>
<a name="256" href="#256">256</a> <em>     *  &lt;p></em>
<a name="257" href="#257">257</a> <em>     *  Namespace prefix-to-URI mappings in an XPath are independent</em>
<a name="258" href="#258">258</a> <em>     *  of those used within any document.  Only the mapping explicitly</em>
<a name="259" href="#259">259</a> <em>     *  added to this XPath will be available for resolving the</em>
<a name="260" href="#260">260</a> <em>     *  XPath expression.</em>
<a name="261" href="#261">261</a> <em>     *  &lt;/p></em>
<a name="262" href="#262">262</a> <em>     *</em>
<a name="263" href="#263">263</a> <em>     *  &lt;p></em>
<a name="264" href="#264">264</a> <em>     *  This is a convenience method for adding mappings to the</em>
<a name="265" href="#265">265</a> <em>     *  default {@link NamespaceContext} in place for this XPath.</em>
<a name="266" href="#266">266</a> <em>     *  If you have installed a specific custom &lt;code>NamespaceContext&lt;/code>,</em>
<a name="267" href="#267">267</a> <em>     *  then this method will throw a &lt;code>JaxenException&lt;/code>.</em>
<a name="268" href="#268">268</a> <em>     *  &lt;/p></em>
<a name="269" href="#269">269</a> <em>     *</em>
<a name="270" href="#270">270</a> <em>     *  @param prefix the namespace prefix</em>
<a name="271" href="#271">271</a> <em>     *  @param uri the namespace URI</em>
<a name="272" href="#272">272</a> <em>     *</em>
<a name="273" href="#273">273</a> <em>     *  @throws JaxenException if a &lt;code>NamespaceContext&lt;/code></em>
<a name="274" href="#274">274</a> <em>     *          used by this XPath has been explicitly installed</em>
<a name="275" href="#275">275</a> <em>     */</em>
<a name="276" href="#276">276</a>     <strong>void</strong> addNamespace(String prefix,
<a name="277" href="#277">277</a>                       String uri)
<a name="278" href="#278">278</a>         throws JaxenException;
<a name="279" href="#279">279</a> 
<a name="280" href="#280">280</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="281" href="#281">281</a>     <em class="comment">//     Properties</em>
<a name="282" href="#282">282</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="283" href="#283">283</a>     
<a name="284" href="#284">284</a>     <em>/**</em><em> Set a &lt;code>NamespaceContext&lt;/code> for  this</em>
<a name="285" href="#285">285</a> <em>     *  XPath expression.</em>
<a name="286" href="#286">286</a> <em>     *</em>
<a name="287" href="#287">287</a> <em>     *  &lt;p></em>
<a name="288" href="#288">288</a> <em>     *  A &lt;code>NamespaceContext&lt;/code> is responsible for translating</em>
<a name="289" href="#289">289</a> <em>     *  namespace prefixes within the expression into namespace URIs.</em>
<a name="290" href="#290">290</a> <em>     *  &lt;/p></em>
<a name="291" href="#291">291</a> <em>     *</em>
<a name="292" href="#292">292</a> <em>     *  @see NamespaceContext</em>
<a name="293" href="#293">293</a> <em>     *  @see NamespaceContext#translateNamespacePrefixToUri</em>
<a name="294" href="#294">294</a> <em>     *</em>
<a name="295" href="#295">295</a> <em>     *  @param namespaceContext the &lt;code>NamespaceContext&lt;/code> to</em>
<a name="296" href="#296">296</a> <em>     *         install for this expression</em>
<a name="297" href="#297">297</a> <em>     */</em>
<a name="298" href="#298">298</a>     <strong>void</strong> setNamespaceContext(<a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> namespaceContext);
<a name="299" href="#299">299</a> 
<a name="300" href="#300">300</a>     <em>/**</em><em> Set a &lt;code>FunctionContext&lt;/code> for  this XPath</em>
<a name="301" href="#301">301</a> <em>     *  expression.</em>
<a name="302" href="#302">302</a> <em>     *</em>
<a name="303" href="#303">303</a> <em>     *  &lt;p></em>
<a name="304" href="#304">304</a> <em>     *  A &lt;code>FunctionContext&lt;/code> is responsible for resolving</em>
<a name="305" href="#305">305</a> <em>     *  all function calls used within the expression.</em>
<a name="306" href="#306">306</a> <em>     *  &lt;/p></em>
<a name="307" href="#307">307</a> <em>     *</em>
<a name="308" href="#308">308</a> <em>     *  @see FunctionContext</em>
<a name="309" href="#309">309</a> <em>     *  @see FunctionContext#getFunction</em>
<a name="310" href="#310">310</a> <em>     *</em>
<a name="311" href="#311">311</a> <em>     *  @param functionContext the &lt;code>FunctionContext&lt;/code> to</em>
<a name="312" href="#312">312</a> <em>     *         install for this expression</em>
<a name="313" href="#313">313</a> <em>     */</em>
<a name="314" href="#314">314</a>     <strong>void</strong> setFunctionContext(<a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> functionContext);
<a name="315" href="#315">315</a> 
<a name="316" href="#316">316</a>     <em>/**</em><em> Set a &lt;code>VariableContext&lt;/code> for this XPath</em>
<a name="317" href="#317">317</a> <em>     *  expression.</em>
<a name="318" href="#318">318</a> <em>     *</em>
<a name="319" href="#319">319</a> <em>     *  &lt;p></em>
<a name="320" href="#320">320</a> <em>     *  A &lt;code>VariableContext&lt;/code> is responsible for resolving</em>
<a name="321" href="#321">321</a> <em>     *  all variables referenced within the expression.</em>
<a name="322" href="#322">322</a> <em>     *  &lt;/p></em>
<a name="323" href="#323">323</a> <em>     *</em>
<a name="324" href="#324">324</a> <em>     *  @see VariableContext</em>
<a name="325" href="#325">325</a> <em>     *  @see VariableContext#getVariableValue</em>
<a name="326" href="#326">326</a> <em>     *</em>
<a name="327" href="#327">327</a> <em>     *  @param variableContext the &lt;code>VariableContext&lt;/code> to</em>
<a name="328" href="#328">328</a> <em>     *         install for this expression.</em>
<a name="329" href="#329">329</a> <em>     */</em>
<a name="330" href="#330">330</a>     <strong>void</strong> setVariableContext(<a href="../../org/jaxen/VariableContext.html">VariableContext</a> variableContext);
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>     <em>/**</em><em> Retrieve the &lt;code>NamespaceContext&lt;/code> used by this XPath</em>
<a name="333" href="#333">333</a> <em>     *  expression.</em>
<a name="334" href="#334">334</a> <em>     *</em>
<a name="335" href="#335">335</a> <em>     *  &lt;p></em>
<a name="336" href="#336">336</a> <em>     *  A &lt;code>FunctionContext&lt;/code> is responsible for resolving</em>
<a name="337" href="#337">337</a> <em>     *  all function calls used within the expression.</em>
<a name="338" href="#338">338</a> <em>     *  &lt;/p></em>
<a name="339" href="#339">339</a> <em>     *</em>
<a name="340" href="#340">340</a> <em>     *  &lt;p></em>
<a name="341" href="#341">341</a> <em>     *  If this XPath expression has not previously had a &lt;code>NamespaceContext&lt;/code></em>
<a name="342" href="#342">342</a> <em>     *  installed, a new default &lt;code>NamespaceContext&lt;/code> will be created,</em>
<a name="343" href="#343">343</a> <em>     *  installed and returned.</em>
<a name="344" href="#344">344</a> <em>     *  &lt;/p></em>
<a name="345" href="#345">345</a> <em>     *</em>
<a name="346" href="#346">346</a> <em>     *  @see NamespaceContext</em>
<a name="347" href="#347">347</a> <em>     *</em>
<a name="348" href="#348">348</a> <em>     *  @return the &lt;code>NamespaceContext&lt;/code> used by this expression</em>
<a name="349" href="#349">349</a> <em>     */</em>
<a name="350" href="#350">350</a>     <a href="../../org/jaxen/NamespaceContext.html">NamespaceContext</a> getNamespaceContext();
<a name="351" href="#351">351</a> 
<a name="352" href="#352">352</a>     <em>/**</em><em> Retrieve the &lt;code>FunctionContext&lt;/code> used by this XPath</em>
<a name="353" href="#353">353</a> <em>     *  expression.</em>
<a name="354" href="#354">354</a> <em>     *</em>
<a name="355" href="#355">355</a> <em>     *  &lt;p></em>
<a name="356" href="#356">356</a> <em>     *  A &lt;code>FunctionContext&lt;/code> is responsible for resolving</em>
<a name="357" href="#357">357</a> <em>     *  all function calls used within the expression.</em>
<a name="358" href="#358">358</a> <em>     *  &lt;/p></em>
<a name="359" href="#359">359</a> <em>     *</em>
<a name="360" href="#360">360</a> <em>     *  &lt;p></em>
<a name="361" href="#361">361</a> <em>     *  If this XPath expression has not previously had a &lt;code>FunctionContext&lt;/code></em>
<a name="362" href="#362">362</a> <em>     *  installed, a new default &lt;code>FunctionContext&lt;/code> will be created,</em>
<a name="363" href="#363">363</a> <em>     *  installed and returned.</em>
<a name="364" href="#364">364</a> <em>     *  &lt;/p></em>
<a name="365" href="#365">365</a> <em>     *</em>
<a name="366" href="#366">366</a> <em>     *  @see FunctionContext</em>
<a name="367" href="#367">367</a> <em>     *</em>
<a name="368" href="#368">368</a> <em>     *  @return the &lt;code>FunctionContext&lt;/code> used by this expression</em>
<a name="369" href="#369">369</a> <em>     */</em>
<a name="370" href="#370">370</a>     <a href="../../org/jaxen/FunctionContext.html">FunctionContext</a> getFunctionContext();
<a name="371" href="#371">371</a> 
<a name="372" href="#372">372</a>     <em>/**</em><em> Retrieve the &lt;code>VariableContext&lt;/code> used by this XPath</em>
<a name="373" href="#373">373</a> <em>     *  expression.</em>
<a name="374" href="#374">374</a> <em>     *</em>
<a name="375" href="#375">375</a> <em>     *  &lt;p></em>
<a name="376" href="#376">376</a> <em>     *  A &lt;code>VariableContext&lt;/code> is responsible for resolving</em>
<a name="377" href="#377">377</a> <em>     *  all variables referenced within the expression.</em>
<a name="378" href="#378">378</a> <em>     *  &lt;/p></em>
<a name="379" href="#379">379</a> <em>     *</em>
<a name="380" href="#380">380</a> <em>     *  &lt;p></em>
<a name="381" href="#381">381</a> <em>     *  If this XPath expression has not previously had a &lt;code>VariableContext&lt;/code></em>
<a name="382" href="#382">382</a> <em>     *  installed, a new default &lt;code>VariableContext&lt;/code> will be created,</em>
<a name="383" href="#383">383</a> <em>     *  installed and returned.</em>
<a name="384" href="#384">384</a> <em>     *  &lt;/p></em>
<a name="385" href="#385">385</a> <em>     *</em>
<a name="386" href="#386">386</a> <em>     *  @see VariableContext</em>
<a name="387" href="#387">387</a> <em>     *  </em>
<a name="388" href="#388">388</a> <em>     *  @return the &lt;code>VariableContext&lt;/code> used by this expression</em>
<a name="389" href="#389">389</a> <em>     */</em>
<a name="390" href="#390">390</a>     <a href="../../org/jaxen/VariableContext.html">VariableContext</a> getVariableContext();
<a name="391" href="#391">391</a>     
<a name="392" href="#392">392</a> 
<a name="393" href="#393">393</a>     <em>/**</em><em> Retrieve the XML object-model-specific {@link Navigator} </em>
<a name="394" href="#394">394</a> <em>     *  used to evaluate this XPath expression.</em>
<a name="395" href="#395">395</a> <em>     *</em>
<a name="396" href="#396">396</a> <em>     *  @return the implementation-specific &lt;code>Navigator&lt;/code></em>
<a name="397" href="#397">397</a> <em>     */</em>
<a name="398" href="#398">398</a>     <a href="../../org/jaxen/Navigator.html">Navigator</a> getNavigator();
<a name="399" href="#399">399</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

